Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

[Docs] Refactor docs #1102

Merged
merged 15 commits into from
Jul 2, 2021
Merged

[Docs] Refactor docs #1102

merged 15 commits into from
Jul 2, 2021

Conversation

zhouzaida
Copy link
Collaborator

@zhouzaida zhouzaida commented Jun 16, 2021 •
edited
Loading

Thanks for your contribution and we appreciate it a lot. The following instructions would make your pull request more healthy and more easily get feedback. If you do not understand some items, don't worry, just make the pull request and seek help from maintainers.

Motivation

Refactor the documentation. Documentation can be visited at https://mmcv-refactor-docs.readthedocs.io/en/latest/

Modification

Please briefly describe what modification is made in this PR.

BC-breaking (Optional)

Does the modification introduce changes that break the back-compatibility of the downstream repos?
If so, please describe how it breaks the compatibility and how the downstream projects should modify their code to keep compatibility with this PR.

Use cases (Optional)

If this PR introduces a new feature, it is better to list some use cases here, and update the documentation.

Checklist

  1. Pre-commit or other linting tools are used to fix the potential lint issues.
  2. The modification is covered by complete unit tests. If not, please add more unit test to ensure the correctness.
  3. If the modification has potential influence on downstream projects, this PR should be tested with downstream projects, like MMDet or MMCls.
  4. The documentation has been modified accordingly, like docstring or example tutorials.

@codecov
Copy link

codecov bot commented Jun 16, 2021 •
edited
Loading

Codecov Report

Merging #1102 (47386dd) into master (76d9bf1) will increase coverage by 0.03%.
The diff coverage is 44.44%.

❗ Current head 47386dd differs from pull request most recent head 88f3060. Consider uploading reports for the commit 88f3060 to get more accurate results
Impacted file tree graph

@@            Coverage Diff             @@
##           master    #1102      +/-   ##
==========================================
+ Coverage   67.96%   67.99%   +0.03%     
==========================================
  Files         159      159              
  Lines       10416    10426      +10     
  Branches     1896     1897       +1     
==========================================
+ Hits         7079     7089      +10     
+ Misses       2969     2968       -1     
- Partials      368      369       +1
Flag Coverage Δ
unittests 67.99% <44.44%> (+0.03%) ⬆️

Flags with carried forward coverage won't be shown. Click here to find out more.

Impacted Files Coverage Δ
mmcv/parallel/distributed.py 22.44% <20.00%> (+1.61%) ⬆️
mmcv/ops/saconv.py 83.58% <25.00%> (-4.95%) ⬇️
mmcv/runner/fp16_utils.py 58.38% <25.00%> (+0.26%) ⬆️
mmcv/cnn/bricks/activation.py 88.00% <50.00%> (+0.50%) ⬆️
mmcv/parallel/distributed_deprecated.py 67.39% <50.00%> (+0.72%) ⬆️
mmcv/runner/dist_utils.py 50.49% <50.00%> (+0.49%) ⬆️
mmcv/runner/hooks/logger/tensorboard.py 36.36% <50.00%> (+1.98%) ⬆️
mmcv/runner/hooks/optimizer.py 17.29% <50.00%> (+0.62%) ⬆️
mmcv/runner/epoch_based_runner.py 83.80% <66.66%> (+0.95%) ⬆️
mmcv/runner/iter_based_runner.py 57.85% <66.66%> (+0.71%) ⬆️
... and 1 more

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 76d9bf1...88f3060. Read the comment docs.

@zhouzaida zhouzaida requested review from ZwwWayne and hellock June 17, 2021 06:06
ZwwWayne
ZwwWayne reviewed Jun 18, 2021
View reviewed changes
docs/understand-the-mmcv/registry.md Outdated Show resolved Hide resolved
docs/community/contributing.md Outdated
@@ -0,0 +1,69 @@
## Contributing to OpenMMLab

Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Downstream OpenMMLab projects all rely on the CONTRIBUTING.md at https://github.com/open-mmlab/mmcv/blob/master/CONTRIBUTING.md

docs/community.rst Show resolved Hide resolved
@zhouzaida zhouzaida changed the title Refactor docs [Docs] Refactor docs Jun 20, 2021
@zhouzaida zhouzaida mentioned this pull request Jun 21, 2021
Closed
13 tasks
@ZwwWayne ZwwWayne mentioned this pull request Jun 27, 2021
Closed
20 tasks
@ZwwWayne ZwwWayne requested a review from innerlee June 28, 2021 09:42
ZwwWayne
ZwwWayne reviewed Jul 2, 2021
View reviewed changes
docs/index.rst Outdated Show resolved Hide resolved
ZwwWayne
ZwwWayne reviewed Jul 2, 2021
View reviewed changes
docs/getting-started.rst Outdated Show resolved Hide resolved
@ZwwWayne ZwwWayne merged commit 66cefaf into open-mmlab:master Jul 2, 2021
@zhouzaida zhouzaida deleted the refactor-docs branch July 2, 2021 13:04
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@innerlee innerlee innerlee left review comments

@ZwwWayne ZwwWayne ZwwWayne approved these changes

@hellock hellock Awaiting requested review from hellock

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
3 participants
@zhouzaida @innerlee @ZwwWayne